home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / tk / button.man < prev    next >
Encoding:
Text File  |  1992-08-24  |  10.7 KB  |  381 lines
  1. '\"
  2. '\" Copyright 1990 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/wish/man/RCS/button.man,v 1.17 92/05/29 14:01:19 ouster Exp $ SPRITE (Berkeley)
  11. '/" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS button cmds
  189. .BS
  190. '\" Note:  do not modify the .SH NAME line immediately below!
  191. .SH NAME
  192. button \- Create and manipulate button widgets
  193. .SH SYNOPSIS
  194. \fBbutton\fI \fIpathName \fR?\fIoptions\fR?
  195. .SH "STANDARD OPTIONS"
  196. .LP
  197. .nf
  198. .ta 4c 8c 12c
  199. .VS
  200. \fBactiveBackground\fR    \fBbitmap\fR    \fBfont\fR    \fBrelief\fR
  201. \fBactiveForeground\fR    \fBborderWidth\fR    \fBforeground\fR    \fBtext\fR
  202. \fBanchor\fR    \fBcursor\fR    \fBpadX\fR    \fBtextVariable\fR
  203. \fBbackground\fR    \fBdisabledForeground\fR    \fBpadY\fR
  204. .VE
  205. .fi
  206. .LP
  207. See the ``options'' manual entry for details on the standard options.
  208. .SH "WIDGET-SPECIFIC OPTIONS"
  209. .ta 4c
  210. .LP
  211. .nf
  212. Name:    \fBcommand\fR
  213. Class:    \fBCommand\fR
  214. Command-Line Switch:    \fB\-command\fR
  215. .fi
  216. .IP
  217. Specifies a Tcl command to associate with the button.  This command
  218. is typically invoked when mouse button 1 is released over the button
  219. window.
  220. .LP
  221. .nf
  222. .VS
  223. Name:    \fBheight\fR
  224. Class:    \fBHeight\fR
  225. Command-Line Switch:    \fB\-height\fR
  226. .fi
  227. .IP
  228. Specifies a desired height for the button.
  229. If a bitmap is being displayed in the button then the value is in
  230. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  231. for text it is in lines of text.
  232. If this option isn't specified, the button's desired height is computed
  233. from the size of the bitmap or text being displayed in it.
  234. .LP
  235. .nf
  236. Name:    \fBstate\fR
  237. Class:    \fBState\fR
  238. Command-Line Switch:    \fB\-state\fR
  239. .fi
  240. .IP
  241. Specifies one of three states for the button:  \fBnormal\fR, \fBactive\fR,
  242. or \fBdisabled\fR.  In normal state the button is displayed using the
  243. \fBforeground\fR and \fBbackground\fR options.  The active state is
  244. typically used when the pointer is over the button.  In active state
  245. the button is displayed using the \fBactiveForeground\fR and
  246. \fBactiveBackground\fR options.  Disabled state means that the button
  247. is insensitive:  it doesn't activate and doesn't respond to mouse
  248. button presses.  In this state the \fBdisabledForeground\fR and
  249. \fBbackground\fR options determine how the button is displayed.
  250. .LP
  251. .nf
  252. Name:    \fBwidth\fR
  253. Class:    \fBWidth\fR
  254. Command-Line Switch:    \fB\-width\fR
  255. .fi
  256. .IP
  257. Specifies a desired width for the button.
  258. If a bitmap is being displayed in the button then the value is in
  259. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  260. for text it is in characters.
  261. If this option isn't specified, the button's desired width is computed
  262. from the size of the bitmap or text being displayed in it.
  263. .VE
  264. .BE
  265.  
  266. .SH DESCRIPTION
  267. .PP
  268. The \fBbutton\fR command creates a new window (given by the
  269. \fIpathName\fR argument) and makes it into a button widget.
  270. Additional
  271. options, described above, may be specified on the command line
  272. or in the option database
  273. to configure aspects of the button such as its colors, font,
  274. text, and initial relief.  The \fBbutton\fR command returns its
  275. \fIpathName\fR argument.  At the time this command is invoked,
  276. there must not exist a window named \fIpathName\fR, but
  277. \fIpathName\fR's parent must exist.
  278. .PP
  279. A button is a widget
  280. .VS
  281. that displays a textual string or bitmap.
  282. It can display itself in either of three different ways, according
  283. to
  284. the \fBstate\fR option; 
  285. .VE
  286. it can be made to appear raised, sunken, or flat;
  287. and it can be made to flash.  When a user invokes the
  288. button (by pressing mouse button 1 with the cursor over the
  289. button), then the Tcl command specified in the \fB\-command\fR
  290. option is invoked.
  291.  
  292. .SH "WIDGET COMMAND"
  293. .PP
  294. The \fBbutton\fR command creates a new Tcl command whose
  295. name is \fIpathName\fR.  This
  296. command may be used to invoke various
  297. operations on the widget.  It has the following general form:
  298. .DS C
  299. \fIpathName option \fR?\fIarg arg ...\fR?
  300. .DE
  301. \fIOption\fR and the \fIarg\fRs
  302. determine the exact behavior of the command.  The following
  303. commands are possible for button widgets:
  304. .TP
  305. \fIpathName \fBactivate\fR
  306. Change the button's state to \fBactive\fR and redisplay the button
  307. using its active foreground and background colors instead of normal
  308. colors.
  309. .VS
  310. This command is ignored if the button's state is \fBdisabled\fR.
  311. This command is obsolete and will eventually be removed;
  312. use ``\fIpathName \fBconfigure \-state active\fR'' instead.
  313. .VE
  314. .TP
  315. \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
  316. Query or modify the configuration options of the widget.
  317. If no \fIoption\fR is specified, returns a list describing all of
  318. the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
  319. information on the format of this list).  If \fIoption\fR is specified
  320. with no \fIvalue\fR, then the command returns a list describing the
  321. one named option (this list will be identical to the corresponding
  322. sublist of the value returned if no \fIoption\fR is specified).  If
  323. one or more \fIoption\-value\fR pairs are specified, then the command
  324. modifies the given widget option(s) to have the given value(s);  in
  325. this case the command returns an empty string.
  326. \fIOption\fR may have any of the values accepted by the \fBbutton\fR
  327. command.
  328. .TP
  329. \fIpathName \fBdeactivate\fR
  330. Change the button's state to \fBnormal\fR and redisplay the button
  331. using its normal foreground and background colors.
  332. .VS
  333. This command is ignored if the button's state is \fBdisabled\fR.
  334. This command is obsolete and will eventually be removed;
  335. use ``\fIpathName \fBconfigure \-state normal\fR'' instead.
  336. .VE
  337. .TP
  338. \fIpathName \fBflash\fR
  339. Flash the button.  This is accomplished by redisplaying the button
  340. several times, alternating between active and normal colors.  At
  341. the end of the flash the button is left in the same normal/active
  342. state as when the command was invoked.
  343. .VS
  344. This command is ignored if the button's state is \fBdisabled\fR.
  345. .VE
  346. .TP
  347. \fIpathName \fBinvoke\fR
  348. .VS
  349. Invoke the Tcl command associated with the button, if there is one.
  350. The return value is the return value from the Tcl command, or an
  351. empty string if there is no command associated with the button.
  352. This command is ignored if the button's state is \fBdisabled\fR.
  353. .VE
  354.  
  355. .SH "DEFAULT BINDINGS"
  356. .PP
  357. .VS
  358. Tk automatically creates class bindings for buttons that give them
  359. the following default behavior:
  360. .IP [1]
  361. The button activates whenever the mouse passes over it and deactivates
  362. whenever the mouse leaves the button.
  363. .IP [2]
  364. The button's relief is changed to sunken whenever mouse button 1 is
  365. pressed over the button, and the relief is restored to its original
  366. value when button 1 is later released.
  367. .IP [3]
  368. If mouse button 1 is pressed over the button and later released over
  369. the button, the button is invoked.  However, if the mouse is not
  370. over the button when button 1 is released, then no invocation occurs.
  371. .PP
  372. If the button's state is \fBdisabled\fR then none of the above
  373. actions occur:  the button is completely non-responsive.
  374. .PP
  375. The behavior of buttons can be changed by defining new bindings for
  376. individual widgets or by redefining the class bindings.
  377. .VE
  378.  
  379. .SH KEYWORDS
  380. button, widget
  381.